2.2.2. Querry string parametrs
Parametrs
Main Parameters
| Parameter | Description | Mandatory | Type | Notes |
|---|---|---|---|---|
| country | Country code | Yes | ||
| name | Organization name | Yes | ||
| fiscal_id | Tax identification number | Yes | ||
| is_legal | Indicator of legal entity (true/false) | |||
| contract_num | Contract number | Yes | ||
| contact_name | Contact person | |||
| region | Region name; if not found in the directory, it will be added | |||
| district | District name; if not found in the directory, it will be added | |||
| address | Organization address | |||
| Email address | ||||
| phone | Organization phone number | |||
| activities | Array of activity types | array of objects | See activities Array Structure below | |
| shop_name | Store name; mandatory and key if shop code is not used | Yes (if shop code not used) | ||
| shop_address | Store address | |||
| shop_phone | Store phone number | |||
| shop_code | Store code | Mandatory if used | ||
| shop_type | Type of retail outlet | |||
| license_num | Cash register license number; mandatory and key | Yes | ||
| token | Cash register fiscal token | |||
| spec_price | Special price (if applied) | |||
| activated_packages | Activated packages | array of objects | See activated_packages Array Structure below | |
| activated_services | Activated services | array of objects | See activated_services Array Structure below | |
| prepay_amount | Prepayment amount | |||
| payment_type | Payment type code | |||
| order_amount | Amount for issuing the initial invoice |
activities Array Structure
| Parameter | Description | Mandatory | Type | Notes |
|---|---|---|---|---|
| code | Activity code | |||
| name | Activity name |
activated_packages Array Structure
| Parameter | Description | Mandatory | Type | Notes |
|---|---|---|---|---|
| code | Package code | |||
| date_from | Activation start date | |||
| date_for | Activation end date | |||
| price | Specialized package price |
activated_services Array Structure
| Parameter | Description | Mandatory | Type | Notes |
|---|---|---|---|---|
| code | Service code | Yes | string | |
| date_from | Activation start date | Yes | date/string | |
| date_for | Activation end date | Yes | date/string | |
| price | Specialized service price | Yes | number |
Code structure
{
"country": "",
"name": "",
"fiscal_id": "",
"is_legal": true,
"contract_num": "",
"contact_name": "",
"region": "",
"district": "",
"address": "",
"email": "",
"phone": "",
"activities": [
{
"code": "",
"name": ""
}
],
"shop_name": "",
"shop_address": "",
"shop_phone": "",
"shop_code": "",
"shop_type": "",
"license_num": "",
"token": "",
"spec_price": 0,
"activated_packages": [
{
"code": "",
"date_from": "",
"date_for": "",
"price": 0
}
],
"activated_services": [
{
"code": "",
"date_from": "",
"date_for": "",
"price": 0
}
],
"prepay_amount": 0,
"payment_type": "",
"order_amount": 0
}
Field Descriptions
- country – Country code, required
- name – Organization name, required
- fiscal_id – Tax identification number, required
- is_legal – Flag indicating a legal entity (true|false)
- contract_num – Contract number, required
- contact_name – Contact person
- region – Region name; if not found in the directory, it will be added
- district – District name; if not found in the directory, it will be added
- address – Organization address, required
- email – Email, required
- phone – Organization phone number, required
- activities – Array of activity types, each object contains:
- code – Activity code
- name – Activity name
- shop_name – Store name, required and key if a store code is not used
- shop_address – Store address
- shop_phone – Store phone number
- shop_code – Store code, key if used
- shop_type – Type of retail outlet
- license_num – Cash register license number, required and key
- token – Cash register fiscal token number
- spec_price – Special price if applied
- activated_packages – Array of activated packages, each object contains:
- code – Package code
- date_from – Start date
- date_for – End date
- price – Specialized package price
- activated_services – Array of activated services, each object contains:
- code – Service code
- date_from – Start date
- date_for – End date
- price – Specialized service price
- prepay_amount – Prepayment amount
- payment_type – Payment type code
- order_amount – Amount for issuing the initial invoice